11.2 Custom scope configuration files

Custom scope configuration files each contain the details for a single scope, which is identified by its Name. If the Name already exists in the appsettings.Production.json or appsettings.json file, the details from the custom scope configuration file completely replace the existing settings for that scope; if the Name does not exist, the scope is added to the configuration for the web service.

Note: You can continue to use the appsettings.Production.json file for your scope configuration if you want, but you are recommended to move any scopes you have created into their own custom scope configuration files.

To create a custom scope configuration file:

  1. On the MyID web server, navigate to the CustomScopes folder.

    By default, this is:

    C:\Program Files\Intercede\MyID\web.oauth2\CustomScopes\

    If this folder does not already exist, create it.

  2. In a text editor, create a .json file to contain your scope configuration.

    You can use any filename with a .json extension; you are recommended to use the name you have provided for the scope as the filename.

    You can create a custom .json file for each scope that you want to add. You can include only one scope in each file, but you can have multiple files if you need multiple scopes. These scopes are added to the Scopes array from the appsettings.json file. You must use a unique Name; if you use the same Name in a custom file as an already existing scope in the appsettings file, the information from the custom file completely replaces the information in the appsettings.json or appsettings.Production.json override file.

    The order of precedence is:

    • any .json file in the CustomScopes folder.

    • appsettings.Production.json

    • appsettings.json

    Note: The appsettings.Production.json file overrides the appsettings.json file not by using the Name, but by the index of the entry in the Scopes array. For this reason, you are recommended not to use the appsettings.Production.json file to provide the details of custom scopes, but to use separate files in the CustomScopes folder instead.